Skip to content

feat(jenkins): remove deprecated 'jenkins' package #5793

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

feat(jenkins): remove deprecated 'jenkins' package #5793

wants to merge 9 commits into from

Conversation

@CryptoRodeo
Copy link
Contributor

@CryptoRodeo CryptoRodeo commented Oct 15, 2025 •
edited
Loading

Hey, I just made a Pull Request!

Remove the deprecated jenkins NPM package and replace it with a built-in lightweight client.

The goal of this client is for it to be "drop-in" and minimize changes where the original client was called.

Should fix #4984

Basic Jenkins plugin operations

These still work as expected (at least for me 😄)

jenkins-backstage-demo-basic.mp4

Scaffolder functionality

The Scaffolder still works the same:

jenkins-scaffolder-demo-basic.mp4

For reference here is the template I used:

apiVersion: scaffolder.backstage.io/v1beta3
kind: Template
metadata:
  name: debug-jenkins
  title: Debug Jenkins
spec:
  owner: guests
  type: service
  system: examples
  lifecycle: experimental
  steps:
    - id: create
      name: Create Jenkins job
      action: jenkins:job:create
      input:
        jobName: demo
        jobXml: |
          <flow-definition plugin="workflow-job">
            <definition class="org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition" plugin="workflow-cps">
              <script>pipeline { agent any; stages { stage('hi'){steps{ echo 'hello' } } } }</script>
              <sandbox>true</sandbox>
            </definition>
          </flow-definition>

    - id: clone
      name: Clone Jenkins Job
      action: jenkins:job:copy
      input:
        sourceJobName: demo
        targetJobName: demoClone

    - id: build
      name: Trigger build
      action: jenkins:job:build
      input:
        jobName: demo

    - id: disable
      name: Disable job
      action: jenkins:job:disable
      input:
        jobName: demo

    - id: enable
      name: Re-enable job
      action: jenkins:job:enable
      input:
        jobName: demo

    - id: destroy
      name: Destroy job
      action: jenkins:job:destroy
      input:
        jobName: demo

    - id: destroy copy
      name: Destroy job copy
      action: jenkins:job:destroy
      input:
        jobName: demoClone

✔️ Checklist

  • A changeset describing the change and affected packages. (more info)
  • Added or updated documentation
  • Tests for new functionality and regression tests for bug fixes
  • Screenshots attached (for UI changes)
  • All your commits have a Signed-off-by line in the message. (more info)

@backstage-goalie
Copy link
Contributor

backstage-goalie bot commented Oct 15, 2025 •
edited
Loading

Changed Packages

Package Name Package Path Changeset Bump Current Version
@backstage-community/plugin-jenkins-backend workspaces/jenkins/plugins/jenkins-backend minor v0.20.0
@backstage-community/plugin-jenkins-common workspaces/jenkins/plugins/jenkins-common minor v0.12.0
@backstage-community/plugin-scaffolder-backend-module-jenkins workspaces/jenkins/plugins/scaffolder-backend-module-jenkins minor v0.14.0

CryptoRodeo
CryptoRodeo commented Oct 15, 2025
View reviewed changes
@CryptoRodeo
Copy link
Contributor Author

CryptoRodeo commented Oct 17, 2025

So far no issues connecting to my Jenkins instance:

basic-jenkins-test.mp4

Jenkins scaffolder also works:

jenkins-scaffolder-test.mp4

@CryptoRodeo CryptoRodeo self-assigned this Oct 17, 2025
@CryptoRodeo CryptoRodeo force-pushed the feat/new-jenkins-client branch from f2aa3e7 to 73778d2 Compare October 18, 2025 01:56
@CryptoRodeo
feat(jenkins): remove deprecated 'jenkins' NPM package
72bb011 
Remove the deprecated 'jenkins' package and replace it with a built-in,
light-weight client.

Signed-off-by: Bryan Ramos <[email protected]>
@CryptoRodeo CryptoRodeo force-pushed the feat/new-jenkins-client branch from 73778d2 to 72bb011 Compare October 18, 2025 02:01
@CryptoRodeo
Add changeset
a616ebe 
Signed-off-by: Bryan Ramos <[email protected]>
@CryptoRodeo
refactor, add function docs
ecfdbeb 
Signed-off-by: Bryan Ramos <[email protected]>
@CryptoRodeo
Add missing function doc
b318125 
Signed-off-by: Bryan Ramos <[email protected]>
@CryptoRodeo
Simplify some code
3a80ca8 
Signed-off-by: Bryan Ramos <[email protected]>
@CryptoRodeo
Add function docs to utility functions
ca4ece2 
Signed-off-by: Bryan Ramos <[email protected]>
@CryptoRodeo
Update API report
1491f12 
Signed-off-by: Bryan Ramos <[email protected]>
@CryptoRodeo CryptoRodeo marked this pull request as ready for review October 20, 2025 17:05
@CryptoRodeo CryptoRodeo requested a review from a team as a code owner October 20, 2025 17:05
@CryptoRodeo CryptoRodeo requested a review from 04kash October 20, 2025 17:05
@github-actions
Copy link
Contributor

github-actions bot commented Nov 4, 2025

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

@github-actions github-actions bot added the stale label Nov 4, 2025
@CryptoRodeo
Copy link
Contributor Author

CryptoRodeo commented Nov 4, 2025

Bump for stale bot

@awanlin awanlin self-requested a review November 4, 2025 15:40
@github-actions github-actions bot removed the stale label Nov 4, 2025
@awanlin
Copy link
Contributor

awanlin commented Nov 7, 2025

Sorry this isn't getting the review it needs @CryptoRodeo. I'm heads down prepping for BackstageCon on Monday. But this is on my radar to review in full!

@CryptoRodeo
Copy link
Contributor Author

CryptoRodeo commented Nov 8, 2025

No worries. Thanks for the heads up @awanlin , have fun at BackstageCon!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@04kash 04kash Awaiting requested review from 04kash 04kash is a code owner automatically assigned from backstage/community-plugins-maintainers

@awanlin awanlin Awaiting requested review from awanlin

@christoph-jerolimov christoph-jerolimov Awaiting requested review from christoph-jerolimov

At least 1 approving review is required to merge this pull request.

Assignees

@CryptoRodeo CryptoRodeo

Labels

owner/area-maintainers workspace/jenkins

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

🐛 Jenkins: Deprecated [email protected] NPM package

3 participants

@CryptoRodeo @awanlin @backstage-service